StatusIndicator

Kind of class:class
Inherits from:UIComponent < MovieClip
Known subclasses:
Classpath:gfx.controls.StatusIndicator
File last modified:Tuesday, 29 June 2010, 09:03:27
The StatusIndicator component displays the status of an event or action using its timeline as the visual indicator. The value of the StatusIndicator will be interpolated with the minimum and maximum values to generate a frame number that will be played in the component’s timeline. Since the component’s timeline is used to display the status, it provides absolute freedom in creating innovative visual indicators.

Inspectable Properties
A MovieClip that derives from the StatusIndicator component will have the following inspectable properties:
  • visible: Hides the component if set to false.
  • disabled: Disables the component if set to true.
  • value: The status value of an event or action. It is interpolated between the minimum and maximum values to generate a frame number to be played.
  • minimum: The minimum value used to interpolate the target frame.
  • maximum: The maximum value used to interpolate the target frame.
  • enableInitCallback: If set to true, _global.CLIK_loadCallback() will be fired when a component is loaded and _global.CLIK_unloadCallback will be called when the component is unloaded. These methods receive the instance name, target path, and a reference the component as parameters. _global.CLIK_loadCallback and _global.CLIK_unloadCallback should be overriden from the game engine using GFx FunctionObjects.
States
There are no states for the StatusIndicator component. The component’s frames are used to display the status of an event or action.

Events
All event callbacks receive a single Object parameter that contains relevant information about the event. The following properties are common to all events.
  • type: The event type.
  • target: The target that generated the event.
No special events are generated by the StatusIndicator. The properties listed next to the event are provided in addition to the common properties.
  • show: The component’s visible property has been set to true at runtime.
  • hide: The component’s visible property has been set to false at runtime.
    • Component metadata:
      InspectableList
      "disabled"
      "enableInitCallback"
      "maximum"
      "minimum"
      "value"
      "visible"

    Summary


    Constructor
    Instance properties
    • maximum
      • The maximum number the value can be set to.
    • minimum
      • The minimum number the value can be set to.
    • value
      • The current value between the maximum and minimum.
    • position
      • The value of the StatusIndicator, to make it polymorphic with a ScrollIndicator.
    Instance properties inherited from UIComponent
    __height __width _disabled _displayFocus _focused addEventListener cleanUpEvents disabled dispatchEvent displayFocus enableInitCallback focused focusHandlerReference focusTarget hasEventListener height initialized invalidationIntervalID removeAllEventListeners removeEventListener sizeIsInvalid soundMap visible width
    Class methods
    Class methods inherited from UIComponent
    createInstance
    Instance methods
    Instance methods inherited from UIComponent
    changeFocus configUI dispatchEventAndSound dispatchEventToGame draw handleInput initSize invalidate onLoad onLoadImpl onMouseWheel onUnload scrollWheel setSize toString validateNow

    Constructor

    StatusIndicator

    function StatusIndicator (
    )

    The constructor is called when a StatusIndicator or a sub-class of StatusIndicator is instantiated on stage or by using attachMovie() in ActionScript. This component can not be instantiated using new syntax. When creating new components that extend StatusIndicator, ensure that a super() call is made first in the constructor.

    Instance properties

    maximum

    maximum:Number
    (read,write)

    The maximum number the value can be set to.

    minimum

    minimum:Number
    (read,write)

    The minimum number the value can be set to.

    position

    position:Number
    (read,write)

    The value of the StatusIndicator, to make it polymorphic with a ScrollIndicator.

    value

    value:Number
    (read,write)

    The current value between the maximum and minimum.
    See also: